Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only fix cell ID validation issues if asked #244

Merged
merged 5 commits into from
Jan 21, 2022

Conversation

nicholaswold
Copy link
Contributor

Adds a new kwarg to validate called repair which will fix well-known validation errors during the validation process, but only when set to True.

Updates existing functionality to not mutate the notebook contents, but instead fail validation.

See: #243, #235

Nicholas Wold added 3 commits January 20, 2022 11:22
Adds a new kwarg to validate called `repair` which will fix well-known validation
errors during the validation process, but only when set to `True`.

Updates existing functionality to not mutate the notebook contents, but instead
fail validation.
@@ -230,7 +230,7 @@ def better_validation_error(error, version, version_minor):


def validate(nbdict=None, ref=None, version=None, version_minor=None,
relax_add_props=False, nbjson=None):
relax_add_props=False, nbjson=None, repair=False):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make it repair_dup_ids=True to be more specific and better match default behavior today

@@ -258,8 +258,9 @@ def validate(nbdict=None, ref=None, version=None, version_minor=None,
if version is None:
version, version_minor = 1, 0

if ref is None and version >= 4 and version_minor >= 5:
# if we support cell ids ensure default ids are provided
notebook_supports_cell_ids = ref is None and version >= 4 and version_minor >= 5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much cleaner, thanks.

@nicholaswold nicholaswold requested a review from MSeal January 21, 2022 01:11
nbformat/validator.py Outdated Show resolved Hide resolved
@nicholaswold nicholaswold requested a review from MSeal January 21, 2022 17:07
@MSeal MSeal merged commit d073357 into jupyter:master Jan 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants